Add initial code imported from the SDK #7
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
llucax
commented
Jun 13, 2024
llucax
commented
- Import implementation from the SDK v1.0.0rc601
- Add an introduction and example to the package documentation
- Include the package documentation in the website home
- Add a link to the documentation in the README
github-actions
bot
added
part:docs
3 tasks
Marenz
reviewed
Jun 13, 2024
| """Types for holding quantities with units.""" | ||
| """Types for holding quantities with units. | ||
| This library provide types for holding quantities with units. The main goal is to avoid |
There was a problem hiding this comment.
Maybe remove the first sentence as it is equal to the headline
There was a problem hiding this comment.
This is a title/summary, like with git commits. There are some options or places where only the summary line is shown.
The only difference with the SDK is the files are split to have one per quantity type, to have more manageable files. Also `_NoDefaultConstructible` was renamed to `NoDefaultConstructible`, as it is used outside the module it is defined in (`_quantity.py`). It is not exported in `__init__.py` though. In the future it should probably be moved to some core library. The tests are also imported from the SDK but kept in one file, as there are many tests that use multiple quantity types to compose them. Signed-off-by: Leandro Lucarella <[email protected]>
Signed-off-by: Leandro Lucarella <[email protected]>
Signed-off-by: Leandro Lucarella <[email protected]>
Signed-off-by: Leandro Lucarella <[email protected]>
llucax
added
part:docs
Marenz
added
the
cmd:skip-release-notes
Marenz
previously approved these changes
Jun 13, 2024
We'll release v1.0.0 soon, so we should update the edit URL to point to the v1.x.x branch instead of the v0.x.x branch. Signed-off-by: Leandro Lucarella <[email protected]>
|
I updated the branch to v1.x.x to follow the suggestion in frequenz-floss/frequenz-sdk-python#852. I think this is mature enough to go with a v1.0.0. If we want to make breaking changes we can start a new v2.x.x branch, but it will make us asses the cost-benefit from doing that and avoid cheap breaking changes... |
Signed-off-by: Leandro Lucarella <[email protected]>
|
Added release notes assuming v1.0.0 will be released after this is merged. |
Marenz
approved these changes
Jun 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.